home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / cleans11.zip / CLEANSE.DOC < prev    next >
Text File  |  1988-06-23  |  6KB  |  172 lines
  1.  
  2. CLEANSE:  Clean any text file to make an ASCII file, Version 1.1
  3.             
  4.                               (c) 1987,'88
  5.                                           
  6.                                 W. Parke
  7.                              1812 S St. NW
  8.                          Washington,D.C. 20009
  9.  
  10. Description:  The program CLEANSE is a utility for operation
  11.             as a  command under the MS-DOS operating system,
  12.             version 2  or higher.   It is designed to remove 
  13.             extraneous characters  from text files  and make  
  14.             them into ordinary  ASCII text files.   Any non-  
  15.             standard   end-of-line   terminators   will   be 
  16.             replaced  by  a proper  carriage-return-linefeed  
  17.             combination.  The cleansed file can then be used
  18.             by standard  ASCII  text editors  or  printed on
  19.             standard   line  printers.    Several   optional
  20.             switches  are available  to remove extra spaces, 
  21.             remove line indentations,  preserve tabs,  or to
  22.             preserve form feeds.
  23.  
  24. Distribution:  CLEANSE   may be freely  distributed provided
  25.             that it  remains unaltered  and is  not packaged
  26.             with or  in promotion  of any commercial product
  27.             or venture,  except by direct agreement with the
  28.             author.
  29.  
  30. Syntax:     CLEANSE file1 file2 [/switch]
  31.  
  32.             File1 is any text file  which may have  improper
  33.             end-of-line termination  or  extraneous  control
  34.             codes.   CLEANSE  creates  file2  to contain the
  35.             processed text.  If  file2  already  exists, the
  36.             user   will   be   asked   if   file2   is to be
  37.             overwritten.  File2 cannot have the same name as
  38.             file1.  A  DOS  path name may be used to preface
  39.             either file name.   The  following  command line
  40.             switches are allowed:
  41.  
  42.             /ri =  Remove Indentation of lines
  43.             /rs =  Remove extra Space between words
  44.             /st =  Save Tab characters
  45.             /sf =  Save Form Feeds
  46.             
  47. Operation:
  48.  
  49.         CLEANSE removes any extraneous control codes,  makes
  50.         end-of-line termination  in  ASCII  format,  removes
  51.         trailling blanks, drops any parity bits  (bit 7)  on
  52.         characters, and removes the deletes.
  53.         
  54.         The /ri Switch:
  55.         
  56.         By default, indented lines retain indentation.  With
  57.         the /ri switch in force,  lines indented with spaces
  58.         or tabs will have their indentation removed.
  59.         
  60.         The /rs Switch:
  61.         
  62.         ASCII files  are often  created by  word  processors
  63.         which add  extra space  between words  in  order  to
  64.         justify the  right  margin  of text.  The /rs switch
  65.         option will let  CLEANSE  remove extra spaces in the
  66.         text.   Two spaces  will be saved between  sentences
  67.         even with the /rs switch in force.
  68.         
  69.         The /st Switch:
  70.         
  71.         CLEANSE  will  expand  tab  characters  with  spaces
  72.         characters, taking  the tab  stops to  be in columns
  73.         1,9,17,25,33,41, etc. (i.e. separated by 8 columns).
  74.         These positions  are the  assumed tab  stops for  an
  75.         ASCII file  in MS-DOS.  With the /st switch, all tab
  76.         characters will be saved.
  77.  
  78.         The /sf Switch:
  79.         
  80.         CLEANSE  will normally remove all control codes in a
  81.         text file  except  carriage returns  and  linefeeds.    
  82.         Form feeds  are  converted  into a pair of carriage-
  83.         return-linefeeds.   However, with the  /sf switch on
  84.         the command line,  the  form feed character  (0C  in
  85.         hex)  will  be  saved  in the converted  ASCII file.
  86.         This may be desirable if the converted file is to be
  87.         sent to a printer.
  88.  
  89. Example commands:
  90.  
  91.         CLEANSE
  92.         
  93.         will show  a short help screen to remind the user of
  94.         the command syntax.
  95.         
  96.         CLEANSE FOO.TXT FOO.DOC
  97.         
  98.         converts the text file called FOO.TXT into the ASCII
  99.         file called FOO.DOC.
  100.         
  101.         CLEANSE FOO.TXT \DOCS\FOO.DOC /RS/RI
  102.         
  103.         converts the text file  FOO.TXT into  FOO.DOC in the
  104.         subdirectory  DOCS.   Extra spaces  in the text  and
  105.         line indentation are removed.
  106.  
  107. Error Messages:
  108.  
  109.         Two different files must be specified.
  110.  
  111.             CLEANSE found that file1=file2.  The second file
  112.             and path name must be distinct from the first.
  113.  
  114.         Invalid switch given.
  115.  
  116.             A command  line switch  begins  with  the  slash
  117.             character (/) followed by a two character switch
  118.             indicator.   Several switches  are allowed,  and
  119.             they may  appear anywhere  on the  command  line
  120.             after  the   CLEANSE  command   itself.    Space
  121.             separators are not required.
  122.  
  123.         File not found.
  124.  
  125.             The first file name or path is invalid.
  126.  
  127.         No conversion done.
  128.  
  129.             A  request  to  overwrite  an  already  existing
  130.             second file was denied by the user.
  131.  
  132.         Not enough memory.
  133.  
  134.             In order to operate quickly, CLEANSE creates two
  135.             buffers for  the input  and output  files.   The
  136.             input buffer  is the smaller of 64K or the input
  137.             file size.  The output buffer is always 64K.  As
  138.             much as 132K may be required.
  139.  
  140.         Error opening file.
  141.  
  142.             The input  file cannot  be read,  or the  output
  143.             file already exists and cannot be overwritten.
  144.  
  145.         Error creating file.
  146.  
  147.             The output  file may  already exist  as a hidden
  148.             file.
  149.  
  150.         Error reading file.
  151.  
  152.             CLEANSE could  not read  a portion  of the input
  153.             file.
  154.  
  155.         Error writing converted file.
  156.  
  157.             CLEANSE could  not write a portion of the output
  158.             file.  There may be insufficient disk space.
  159.  
  160.         File to receive conversion already exists.
  161.  
  162.             If the  output file  already exists, you will be
  163.             asked if  you wish  to overwrite it.  The answer
  164.             must be Yes or No (y,n,Y,N accepted).
  165.  
  166.  
  167. Version History:
  168.  
  169.            July, 1987  Version 1.0
  170.            June, 1988  Version 1.1  Added removal of trailing blanks
  171.                                     on each line.
  172.